HTTP API: Add missing defaults/enums, fix mistakes #718
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Deploy Preview Available Via |
Simran-B
commented
Jun 24, 2025
Simran-B
commented
Jun 24, 2025
…mention startup options, add missing slowStreamingQueryThreshold option
details parameter would require polymorphic response description (array or object) but we cannot render this at the moment
Simran-B
changed the title
Missing defaults, add uniqueItems property for indexes, fix type/structure mistakes, reword some descriptions Certain endpoints like for transactions would require multiple types (string or array of strings), but we cannot render that yet
nerpaula
reviewed
Aug 5, 2025
nerpaula
reviewed
Aug 5, 2025
nerpaula
reviewed
Aug 5, 2025
nerpaula
reviewed
Aug 5, 2025
nerpaula
reviewed
Aug 5, 2025
nerpaula
reviewed
Aug 5, 2025
nerpaula
approved these changes
Aug 5, 2025
|
/generate-commit |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
TODOs:
For example,
replicationFactoris1by default in a cluster (and ignored in single server), but this depends on the--cluster.default-replication-factorstartup options for user collections and on--cluster.system-replication-factorfor system collections. If the startup options aren't set, then the default is indeed1, but otherwise it has the value of the respective startup option. Should we therefore omitdefault: 1and describe how the default value is determined indescription? --> Describe in description how the default is determined. If we do this as a separate paragraph and likeDefault: Controlled by the--foo.bar` startup option, then it's also quick to find.POST /_api/cursor:--query.optimizer-max-plans--query.max-runtimePUT /_db/{database-name}/_api/query-cache/properties: mention related startup options? (Copy from getting the cache config, or move?)POST /_db/{database-name}/_api/transaction/begin: maxTransactionSize controlled by--transaction.streaming-max-transaction-size- note that this feature has been added in 3.12!Upstream PRs